This guide outlines how to use the Dundas BI RESTful Services. Also included are descriptions of request types, parameters, and request and response example objects.
Dundas BI RESTful Services can be called in many ways. Some popular ways for calling RESTful services are:
HTTP status codes are divided into five categories:
Informational 1xx
Successful 2xx
Redirection 3xx
Client Error 4xx
Server Error 5xx
You will be returned these common HTTP status codes, and other standard REST HTTP status codes when calling Dundas BI Restful Services:
| 200 | Success |
| 201 | Created |
| 204 | No Content |
| 206 | Partial Content |
| 400 | Bad request |
| 404 | Not Found |
| 405 | Method Not allowed |
| 409 | Conflict |
When using the Dundas BI RESTful Services a few simple rules apply.
| HTTP method | Description |
| POST | To create something in Dundas BI |
| GET | Get something in Dundas BI |
| PUT | Update something in Dundas BI |
| DELETE | Delete something in Dundas BI |
One of the great assets when programming with the REST APIs is the Dundas BI website. When using the application, it will make REST calls and you can track their URLs, requests, and responses. This will make it easier to consume this API guide. Below is a quick tutorial about how to use Chrome's Developer Tools to analyze the REST calls needed to create a Dundas BI user account:
Open Dundas BI in the Chrome browser.
Navigate to the Dundas BI logon page.
Click Ctrl+Shift+I on Windows, or Command+Option+I on a Mac to open the developer tools.
Log on to Dundas BI, proceed to the admin screen, and create a user.
In the network tab in the Chrome developer tools:
